Authenticate User

{ handleApiUserPassAuth }

Generates a security access authentication token for the given user to use the API functions.

Method

/API/auth/authenticateUser

  • API Section: /API/auth
  • API Version: 1.0
  • Method operates via POST actions only.

    • NOTE: API 1.0 methods are now deprecated. Use API 2.0 methods instead

    Input Parameters

    Name

    data

    Object Type

    UserCredentials

    Description

    The user credential object used to set a user's login settings.

    Output Response

    Successful Result Code

    200

    Description of Response Type

    successful operation

    Notes

    The security token is a string that needs to be embedded in every API call to ensure the API calls are authorized.